PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

custom_properties

Retrieves a custom_properties resource.

Retrieves a custom_properties resource.

Authorizations:
JWT
path Parameters
id
required
string

custom_properties identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "tableName": "string",
  • "propertyName": "string",
  • "fieldType": "string",
  • "propertyType": "string",
  • "source": "string",
  • "priority": 0,
  • "required": true,
  • "maxLength": 0,
  • "minLength": 0,
  • "notes": "string",
  • "shortcode": "CP",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the custom_properties resource.

Replaces the custom_properties resource.

Authorizations:
JWT
path Parameters
id
required
string

custom_properties identifier

Request Body schema:
required

The updated custom_properties resource

tableName
required
string
propertyName
required
string^([a-zA-Z_\-$][a-zA-Z_\-$0-9]*)$
fieldType
required
string

This is the value type for THE FORM

propertyType
required
string

This is the value type for THE API

source
string or null
priority
integer
required
boolean
maxLength
integer or null
minLength
integer or null
notes
string or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "tableName": "string",
  • "propertyName": "string",
  • "fieldType": "string",
  • "propertyType": "string",
  • "source": "string",
  • "priority": 0,
  • "required": true,
  • "maxLength": 0,
  • "minLength": 0,
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "tableName": "string",
  • "propertyName": "string",
  • "fieldType": "string",
  • "propertyType": "string",
  • "source": "string",
  • "priority": 0,
  • "required": true,
  • "maxLength": 0,
  • "minLength": 0,
  • "notes": "string",
  • "shortcode": "CP",
  • "id": 0,
  • "slug": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uniqueId": "string",
  • "taggingListing": "string"
}

Removes the custom_properties resource.

Removes the custom_properties resource.

Authorizations:
JWT
path Parameters
id
required
string

custom_properties identifier

Responses